home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d1 / batchlrn.arc / PARAM.HLP < prev    next >
Text File  |  1991-06-17  |  12KB  |  172 lines
  1.                 #
  2.                 #
  3. |---------------B A T C H L R N  H E L P  S Y S T E M-----------------|
  4. |commandS:Various paramters used in commands, including batch cmds.   |
  5. |use:To modify or otherwise change the effect of the command.         |
  6. |                                                                     |
  7. |how:Type <command> <parameter> or use parameters in batch files.     |
  8. |                                                                     |
  9. |examples:There are many batch files on this disk you can study to    |
  10. | see how Parameters work. Also see examples included below.          |
  11. |                                                                     |
  12. |explanation:Parameters are extra pieces of information that you type |
  13. | after many DOS cmnds.or in batch file instructions.DIR B:/W,for ex- |
  14. | ample, illustrates modification of the DOS command DIR. By adding   |
  15. | the parameters B: and /W you are modifying basic operation of the   |
  16. | command. You pass parameters to batch files the same way--by typing |
  17. | the information after the batch command, but BEFORE typing the      |
  18. | balance of the information. This process is called "testing". This  |
  19. | will seem complicated at first, but once you get the hang of it you |
  20. | will wonder why you didn't know about batch processing (replaceable)|
  21. | parameters before. Parameters may be used any place in a batch file |
  22. | they are needed to "test" for the presence of something you typed,  |
  23. | (or DIDN'T TYPE) at the prompt (it WILL get clearer!).              |
  24. | The secret to understanding batch file parameters is to slowly work |
  25. | into the subject. The batch processing file uses parameters in sev- |
  26. | eral ways as it is being run and this (at first) makes comprehension|
  27. | difficult. "Markers" are used within the batch file as "signals" as |
  28. | to wh/parameter goes where. Markers are comprised of a percent sign |
  29. | (%) and a single digit between 0 and 9 (that's ten markers in use   |
  30. | at any one time--remember that zero is a number). The %0 is ALWAYS  |
  31. | the NAME OF THE BATCH PROCESSING FILE! As if it wasn't confusing    |
  32. | enough already, many manuals refer to markers as simply "variables".|
  33. | The name, obviously, is not as important as the concept. To cover   |
  34. | this, however, we also have a file called:VAR.HLP. It covers the    |
  35. | fact that THERE IS a difference between parameters and variables.   |
  36. |                                                                     |
  37. | examples: Assume that a batch file named COLORGO.BAT is on the cur- |
  38. | rent drive. This file contains ONLY a  single command:              |
  39. |       ECHO %0 %1 %2 %3  [ECHO shows messages on the screen].        |
  40. | If, at the DOS prompt, you typed: COLORGO Red Blue Green THAT cmd.  |
  41. | would recognize that FOUR parameters were passed to the batch file. |
  42. | The batch file via the ECHO would display them on the screen in the |
  43. | order received (0=colorgo{name of .BAT file}; %1=red; %2=blue & %3= |
  44. | green) in the form you typed in. The parameters and markers were    |
  45. | related,(to restate),as follows... ECHO COLORGO Red Blue Green      |
  46. |                                            %0    %1  %2    %3       |
  47. |          TO EXPLAIN REPLACEABLE PARAMETERS ANOTHER WAY:             |
  48. | You can include dummy parameters within your batch file which DOS   |
  49. | will replace with values you supply on the command line when exe-   |
  50. | cuting the file. Using replaceable parameters allows you to specify |
  51. | DIFFERENT sets of data every time you run the batch file. You can   |
  52. | use up to 10 parameters; if more are needed, the shift command (SEE |
  53. | SHIFT.HLP)can be used to extend the available set. Note that OTHER  |
  54. | areas in the batch file can recognize the %X parameters as well.For |
  55. | example, you might want a message: ECHO ...WORK COMPLETE ON %1      |
  56. | the batch file would repeat the message but replace %1 with the name|
  57. | you typed on the command or prompt line. Examine the .BAT files on  |
  58. | this disk to see many examples of how this is accomplished.         |
  59. | Another example of replaceable parameters is shown below:           |
  60. |                                      |
  61. |                      FINDIT B: ROUND BLUE                           |
  62. |                                      |
  63. | When you type in a command, the command itself (FINDIT) is para-    |
  64. | meter %0. The parameter following the COMMAND (B:) is %1, and so on.|
  65. | In the example, therefore, ROUND=%1 and BLUE=%2 (a % for each word) |
  66. | All parameters following the cmd.take on succesive parameter values.|
  67. |                                      |
  68. | Here is another way to illustrate parameters (the loop file):       |
  69. |                          LOOP MYDEMO.DOC                            |
  70. |             REM - LOOP BATCH FILE FOR %1                            |
  71. |             TYPE %1                                                 |
  72. |             .                                                       |
  73. |             .           (MYDEMO.DOC {%!} is displayed)              |
  74. |             .                                                       |
  75. |             CLS                                                     |
  76. |             LOOP                                                    |
  77. |             REM - LOOP BATCH FILE FOR %1                            |
  78. |             .                                                       |
  79. |             . (FILE IS DISPLAYED again)                             |
  80. |             .                                                       |
  81. |             FILE WILL KEEP GOING UNTIL YOU CTRL C OR CTRL-BREAK     |
  82. |                                                                     |
  83. | While not particularly useful,this batch file serves to demonstrate |
  84. | replaceable parameters. There are a few ways in which such a file   |
  85. | (looping batch file) like the one above could be used. It could     |
  86. | continuously run a software demonstration package or graphics       |
  87. | animation program with a loop. You could also test the integrity of |
  88. | hardware by running a continuous test program over and over until   |
  89. | you stopped it.                              |
  90. |                                              |
  91. | Here's an experiment with replaceable parameters you can try:       |
  92. |                      (Create the following file)                    |
  93. |               COPY CON:SEEFILE.BAT                                  |
  94. |               TYPE %1                                               |
  95. |               TYPE %2                                               |
  96. |               TYPE %3                                               |
  97. |               <F6> <RETURN>                                         |
  98. | This batch file will display,using TYPE,the files that you specify  |
  99. | as the first,second, and third parameters on the command line. Each |
  100. | filename.ext type would be typed in the order requested, on the CRT.|
  101. | screen. You could also use *.* (wildcards) as %1 and it would dis-  |
  102. | play a whole group of files ( or *.DOC to display THOSE files). You |
  103. | could also use *.DOC as %1; *.TXT as %2, etc. When you use MULTIPLE |
  104. | PARAMETERS in a batch file they MUST be separated by spaces. To ill-|
  105. | ustrate:Often you have repetitive tasks which are quite similar,per-|
  106. | haps differing only by the file being processed. A parameter is used|
  107. | to provide a file name to the .BAT file. This way, a batch file can |
  108. | immediately perform a task for you without having to be specially   |
  109. | edited to match your current needs. For example, INFORM.BAT :       |
  110. |                                                                     |
  111. | On monday:                                                          |
  112. |   INFORM THUR.DAT FRI.DAT SAT.DAT SUN.DAT                           |
  113. | On thursday:                                 |
  114. |   INFORM MON.DAT TUE.DAT WED.DAT                                    |
  115. | Up to 10 parameters may be used. Our example, INFORM.BAT would have |
  116. | a command line in its body. It could be COPY %1 + %2 + %3 + %4=A:RE-|
  117. | PORT (which would copy the files into ONE called REPORT which could |
  118. | then be renamed whatever you wanted). Or you could give a PRINT cmd.|
  119. | such as: PRINT %1 %2 %3 %4. There is no limit to your instructions. |
  120. |           REVIEW THE .BAT FILES ON THIS DISK WITH PARAMETERS        |
  121. |                                      |
  122. | There may be times when you want to create an application program   |
  123. | and run it with different sets of data. This data may be stored     |
  124. | in various DOS files. Let's illustrate this & then examine our work.|
  125. | For example, when you type the command line COPY CON DOFILE.BAT,    |
  126. | the next lines you type are copied from the console to a file named |
  127. | DOFILE.BAT on the default drive:                                    |
  128. |                     COPY CON DOFILE.BAT                             |
  129. |                     COPY %1.INF+%2.INF=%2.PRN                       |
  130. |                     TYPE %2.PRN                                     |
  131. |                     PRINT %2.PRN                         |
  132. | Now press <F6> or <ctrl/z> and then press <return>. DOS responds:   |
  133. |                    "1 file(s) copied"                               |
  134. | The file DOFILE.BAT, which consists of three commands, now resides  |
  135. | on the disk in the default drive. It stands ready for variables!    |
  136. | The dummy parameters %1 and %2 are replaced sequentially by the     |
  137. | parameters you supply when you execute the file. The dummy parameter|
  138. | %0 is always replaced by the drive designator, if specified, and    |
  139. | the filename of the batch file (for example:DOFILE).Now let's do it!|
  140. | To execute the batch file DOFILE.BAT and to specify the parameters  |
  141. | that will replace the dummy param.(markers),you must type the batch |
  142. | file name(without its extension) followed by the parameters you     |
  143. | want DOS to substitute for %1, %2, etc. Let's look at what happens: |
  144. |                                                                     |
  145. |       (Remember that the file DOFILE.BAT consists of 3 lines):      |
  146. |                       COPY %1.INF+%2.INF=%2.PRN
  147. |                       TYPE %2.PRN                                   |
  148. |                       PRINT %2.PRN                                  |
  149. | To execute the batch processing file, DOFILE you might type:        |
  150. |                        DOFILE A:DATA1 B:DATA2                       |
  151. | DOFILE is substituted for %0, A:DATA1 for %1, and B:DATA2 for %2.   |
  152. |             (notice how the drives can be inserted)                 |
  153. | The result is the same as if you had typed each of the commands in  |
  154. | DOFILE with their parameters, as follows:                           |
  155. | COPY A:DATA1.INF+B:DATA2.INF=DATA2.PRN [COPY DATA1&DATA2=DATA2.PRN] |
  156. | TYPE B:DATA2.PRN    [DISPLAYING THE COMBINED FILE]                  |
  157. | PRINT B:DATA2.PRN   [PRINT THE COMBINED FILE]                       |
  158. | The following illustrates how DOS replaces each of the parameters:  |
  159. | BATCH    PARAMETER1  (%0)  PARAMETER2  (%1)   PARAMETER3  (%2)      |
  160. | FILENAME  (DOFILE)          (DATA1)             (DATA2)             |
  161. | DOFILE    DOFILE.BAT        DATA1.INF           DATA2.INF           |
  162. |                                                 DATA2.PRN           |
  163. |                                                                     |
  164. |                            NOTES                                    |
  165. | 1. Up to 10 dummy parameters (%0-%9) can be specified. Refer to the |
  166. | DOS command SHIFT if you wish to specify more than 10 parameters.   |
  167. | 2. If you use the percent sign as part of a FILE NAME within a      |
  168. | batch file, you must type it twice. For example, to specify the file|
  169. | XYZ%.BAT, you must type it as XYZ%%.BAT in the batch file.          |
  170. |                                                                     |
  171. |----------------- T  I  M  E  M  A  S  T  E  R  ---------------------|
  172.